MarkLogic 12 Product Documentation
POST /manage/v2/databases/{id|name}/alert/configs

Summary

This resource address creates a new alert configuration. You can use the uri parameter and the add-alert-triggers operation to add the triggers specified in the alert configuration to an existing alert configuration. You can use the uri parameter and the remove-alert-triggers operation to remove the triggers from an existing alert configuration. New alert configurations are done on the content database.

URL Parameters
uri The URI of the alert for which to add or remove triggers.
format The format of the data in the request body. Allowed values: html, json or xml (default). Use this parameter to override the Accept header.
Request Headers
Accept The expected MIME type of the request body. If the format? parameter is present, it takes precedence over the Accept header.
Content-type The MIME type of the data in the request body. Depending upon the value of the format parameter or Accept header, one of application/xml, application/json, or text/html.
Response Headers
Content-type The MIME type of the data in the response body. Depending upon the value of the format parameter or Accept header, one of application/xml, application/json, or text/html.
Location If the request causes a restart, a Location header is included in the reponse. The header contains a path with which to construct a URL to usable to test when the restart has completed.

Response

Upon success, MarkLogic Server returns status code 202 (Accepted). If the alert already exists or if the payload is malformed, a status code of 400 (Bad Request) is returned. A status code of 401 (Unauthorized) is returned if the user does not have the necessary privileges.

Required Privileges

This operation requires one of the following:

Usage Notes

The structure of the data in a create alert request is as shown below.

Note: The properties described here are for XML payloads. In general they are the same for JSON, with the exception that, in JSON, triggers, domains, actions, and options are expressed in singular form.

id

uri

name

description

triggers

The triggers for an alert configuration.

This is a complex structure with the following children:

trigger

domains

The cpf domains for an alert configuration.

This is a complex structure with the following children:

domain

options

This is a complex structure with the following children:

option

actions

This is a complex structure with the following children:

action

The structure of the data in an add-alert-triggers request is as shown below. This operation adds the triggers specified in the alert configuration.


	      {"operation": "add-alert-triggers"}

The structure of the data in an remove-alert-triggers request is as shown below. This operation removes all triggers associated with the alert. 


	      {"operation": "remove-alert-triggers"}

Example


curl -X POST  --anyauth --user admin:admin --header "Content-Type:application/json" \
-d '{
  "uri": "my-alert-config",
  "name": "My Alerting App",
  "description": "Alerting config for my app",
  "trigger": [],
  "domain": [],
  "action": [],
  "option": []
   }' \
http://localhost:8002/manage/v2/databases/Documents/alert/configs

==>  Creates a new alert, named "My Alerting App," for the Documents
     database.

Example


curl -X POST  --anyauth --user admin:admin --header "Content-Type:application/json" \
-d '{"operation": "add-alert-triggers"}' \
http://localhost:8002/manage/v2/databases/Documents/alert/configs?uri=my-alert-config

==>  Adds a new trigger for the 'my-alert-config' alert to the Documents database.
Powered by MarkLogic Server | Terms of Use | Privacy Policy